package cz.muni.fi.pa165.creatures.ejb.dao;

/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.util.List;

import javax.ejb.Local;

import cz.muni.fi.pa165.creatures.ejb.model.Creature;

/**
 * This interface represents a contract for implementation of the DAO for the
 * {@link cz.muni.fi.pa165.creatures.ejb.model.Creature} entity.
 *
 * @author hulek
 */
@Local
public interface CreatureDAOLocal {

    /**
     * This method creates a creature.
     *
     * @param creature creature to create
     */
    void create(Creature creature);

    /**
     * This method removes a creature.
     *
     * @param creature creature to remove
     */
    void remove(Creature creature);

    /**
     * This method updates already existing creature.
     *
     * @param creature creature to update
     */
    void update(Creature creature);

    /**
     * This method gets a creature of some {@code id}.
     *
     * @param id id of the creature we want to get
     * @return creature of specified {@code id}, null otherwise
     */
    Creature get(Long id);

    /**
     * This method returns count of creatures in our simple world.
     *
     * @return number of the all creatures
     */
    Long getCount();

    /**
     * This method returns all creatures in our simple world.
     *
     * @return a list of all creatures, if there are no creatures,
     * the returned list is an empty list, not null, null is
     *         returned when there was an error
     */
    List<Creature> getAll();

    /**
     * This method returns creature by its name
     *
     * @param name name of the creature to get
     * @return creature of the specific name
     */
    public Creature getByName(String name);
}
